home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / kbdset.z / kbdset
Text File  |  1998-10-20  |  13KB  |  198 lines
  1.  
  2.  
  3.  
  4. kkkkbbbbddddsssseeeetttt((((1111))))                                                            kkkkbbbbddddsssseeeetttt((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _kkkk_bbbb_dddd_ssss_eeee_tttt - attach to _kkkk_bbbb_dddd mapping tables, set modes
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _kkkk_bbbb_dddd_ssss_eeee_tttt [_----_oooo_qqqq] [_----_aaaa _t_a_b_l_e] [_----_vvvv _s_t_r_i_n_g] [_----_kkkk _h_o_t_k_e_y] [_----_mmmm _x] [_----_tttt _t_i_c_k_s]
  13.      _kkkk_bbbb_dddd_ssss_eeee_tttt [_----_oooo_qqqq] [_----_dddd _t_a_b_l_e] [_----_vvvv _s_t_r_i_n_g] [_----_kkkk _h_o_t_k_e_y] [_----_mmmm _x] [_----_tttt _t_i_c_k_s]
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      The _kkkk_bbbb_dddd_ssss_eeee_tttt command is the normal user interface to the _kkkk_bbbb_dddd STREAMS
  17.      module.  [See _kkkk_bbbb_dddd_cccc_oooo_mmmm_pppp(1M) and _kkkk_bbbb_dddd(7) for a general description of the
  18.      module's capabilities.]  _kkkk_bbbb_dddd_ssss_eeee_tttt allows users to attach to pre-loaded
  19.      tables, detach from tables, and set options. Options are provided for
  20.      setting hot-keys to toggle tables and for controlling modes of the
  21.      module.
  22.  
  23.      Arguments and options are scanned and acted on in command line order.  If
  24.      the _----_oooo option is given, subsequent options affect the output side of the
  25.      stream, otherwise the input side is assumed.
  26.  
  27.      The _----_qqqq option causes the _kkkk_bbbb_dddd_ssss_eeee_tttt command to list modules which can be
  28.      accessed by the invoking user.  In this case all subsequent options are
  29.      ignored.  The output from the _----_qqqq option lists the user's current hot-key
  30.      settings, current timer value, and for each available table an
  31.      identifier, the name, size, attachments (input and/or output sides),
  32.      reference count, number of components, and type (private or public).  In
  33.      the following example, there is one composite table, two tables are
  34.      attached on the input side, and one on the output side.
  35.  
  36.          _IIII_nnnn _HHHH_oooo_tttt _KKKK_eeee_yyyy _==== _^^^^_____
  37.          _TTTT_iiii_mmmm_eeee_rrrr_ssss_:::: _IIII_nnnn _==== _2222_0000 _;;;; _OOOO_uuuu_tttt _==== _2222_0000
  38.          _IIII_DDDD        _NNNN_aaaa_mmmm_eeee             _SSSS_iiii_zzzz_eeee _IIII_////_OOOO _RRRR_eeee_ffff _CCCC_mmmm_pppp _TTTT_yyyy_pppp_eeee
  39.          _4444_0000_3333_9999_ffff_3333_0000_0000  _UUUU_cccc_aaaa_ssss_eeee              _5555_6666 _---- _oooo   _1111   _----  _eeee_xxxx_tttt
  40.          _4444_0000_3333_aaaa_0000_4444_8888_0000  _CCCC_aaaa_ssss_eeee_////_DDDD_vvvv_oooo_rrrr_aaaa_kkkk        _6666_8888 _---- _----   _0000   _2222  _pppp_rrrr_iiii
  41.                      _[[[[_4444_0000_3333_9999_ffff_3333_0000_0000_]]]]  _[[[[_4444_0000_3333_7777_eeee_4444_0000_0000_]]]]
  42.          _4444_0000_3333_6666_cccc_eeee_0000_0000  _DDDD_eeee_uuuu_tttt_ssss_cccc_hhhh_eeee          _3333_3333_2222 _iiii _----   _4444   _----  _pppp_uuuu_bbbb
  43.          _4444_0000_3333_7777_eeee_4444_0000_0000  _DDDD_vvvv_oooo_rrrr_aaaa_kkkk            _3333_1111_2222 _iiii _----   _2222   _----  _pppp_rrrr_iiii
  44.  
  45.      The _IIII_DDDD field is an identifier unique to a given table (actually its
  46.      address in memory).  Currently attached tables are marked _iiii or _oooo;
  47.      otherwise, the _IIII_////_OOOO fields are marked with a dash.  _RRRR_eeee_ffff is a reference
  48.      count of attached users (including composites that refer to simple
  49.      tables) and if non-zero, indicates that the table is in use.  _SSSS_iiii_zzzz_eeee is the
  50.      total size in bytes of the table and associated overhead in memory.  If
  51.      the table is a composite table, the _CCCC_mmmm_pppp field contains a number instead
  52.      of a dash, and the following line lists an identifier for each component,
  53.      in order of processing (allowing identification of the components in a
  54.      composite table).  Publicly available tables are marked with the type _pppp_uuuu_bbbb
  55.      and private tables with _pppp_rrrr_iiii.  Private tables are available only to the
  56.      invoking user and within the current stream.  Tables which are really
  57.      external functions [see _kkkk_bbbb_dddd(7)] are marked _eeee_xxxx_tttt; they are always of type
  58.      _pppp_uuuu_bbbb.  Tables that are interpreted in timeout [see _kkkk_bbbb_dddd_cccc_oooo_mmmm_pppp(1M)] mode have
  59.  
  60.  
  61.  
  62.                                                                         PPPPaaaaggggeeee 1111
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69. kkkkbbbbddddsssseeeetttt((((1111))))                                                            kkkkbbbbddddsssseeeetttt((((1111))))
  70.  
  71.  
  72.  
  73.      an asterisk (_****) preceding the _TTTT_yyyy_pppp_eeee field; members of composite tables
  74.      that are interpreted in timeout mode have an asterisk after their
  75.      bracketed identifier (on the second output line).  External functions are
  76.      never time-sensitive, unless by their own internal specifications.
  77.  
  78.      The option _----_aaaa accompanied by an argument attaches to the named table.  A
  79.      table may not be multiply attached by a single user.  When a table is
  80.      attached and no other table is already attached, then the table is
  81.      automatically made current.  The option _----_dddd detaches from the named table.
  82.      [See _kkkk_bbbb_dddd_llll_oooo_aaaa_dddd(1M) for a description of how tables are loaded.]
  83.  
  84.      The _----_kkkk option sets the user's hot-key.  Setting a hot-key with only a
  85.      single active table allows mapping to be toggled on and off, depending on
  86.      the hot-key mode.  A hot-key is a single byte, typically set to a
  87.      relatively unused control character, that is caught by the _kkkk_bbbb_dddd module and
  88.      used for module control rather than being translated in any way.  The key
  89.      used as a hot-key becomes unavailable for other uses (unless it is
  90.      generated by mapping).  The hot-key may be reset at any time,
  91.      independently from other options.  Note that _kkkk_bbbb_dddd_ssss_eeee_tttt does not interpret
  92.      ^X-type sequences; it expects a literal hot-key character.
  93.  
  94.      The _----_mmmm option with an integer argument controls the hot-key mode.  Legal
  95.      modes are 0, 1 (the default), and 2.  Mode 0 allows one to toggle through
  96.      the list of attached tables.  Upon reaching the end of the list, the
  97.      cycle returns to the beginning of the list.  Use of Mode 0 with only one
  98.      table loaded does not allow mapping to be turned off.  Mode 1 toggles to
  99.      the unmapped state upon reaching the end of the list (for example, given
  100.      two tables, the sequence is table1, table2, off, table1, and so on).
  101.      Mode 2 toggles to the unmapped (or off) state between every table in the
  102.      list of attached tables (for example, given two tables, the sequence is
  103.      table1, off, table2, off, table1, and so on).
  104.  
  105.      The _----_vvvv option turns on verbose mode, which can be useful when multiple
  106.      tables are used in interactive sessions.  In verbose mode, the name of
  107.      the table can be output to the terminal whenever the user changes to a
  108.      new table with the hot-key.  The string associated with the option can be
  109.      any short string.  If the character sequence _%%%%_nnnn appears in the string,
  110.      the name of the current table (or a null string) will be substituted for
  111.      the _%%%%_nnnn.  (A null argument to _----_vvvv is equivalent to terse mode.)  One useful
  112.      sequence for this mode is _s_a_v_e-_c_u_r_s_o_r _g_o_t_o-_s_t_a_t_u_s-_l_i_n_e _c_l_e_a_r-_t_o-_e_n_d-_o_f-
  113.      _l_i_n_e _%%%%_nnnn _r_e_s_t_o_r_e-_c_u_r_s_o_r.  This causes output of the current table name on
  114.      the terminal's status line; in absence of a status-line, a simple
  115.      sequence is to print the table name and RETURN [see _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo(4) for the
  116.      appropriate escape sequences.]  Verbose mode is only available to show
  117.      input table status to the output side of the stream.  The output string
  118.      for verbose mode is not itself passed through the mapping process, but is
  119.      transmitted directly downstream with no other interpretation (it should
  120.      thus be a string of ASCII characters or in some other externally
  121.      available code set).
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135. kkkkbbbbddddsssseeeetttt((((1111))))                                                            kkkkbbbbddddsssseeeetttt((((1111))))
  136.  
  137.  
  138.  
  139.      The _----_tttt option with an argument is used to change the timer for tables in
  140.      the stream that are interpreted in timeout mode.  Values (in clock ticks)
  141.      between 5 and 400 are acceptable.  (Depending on the hardware, the clock
  142.      is usually either 60Hz or 100Hz, thus one tick is either 1/60 or 1/100 of
  143.      a second; with a bit of experimentation, a suitable value for one's own
  144.      system and typing speed can be found.)  When a table that uses timeout
  145.      mode is attached, it is assigned the current timer value.  All tables
  146.      that are attached after setting the timer value will take on the new
  147.      value, but tables currently attached are unaffected (this allows one to
  148.      set different values for different tables).  The option does not affect
  149.      other users' values.  The timer value may be set independently for input
  150.      and output
  151.      sides by using _----_tttt in conjunction with _----_oooo.  The value for a currently
  152.      attached table may be reset by detaching the table, setting the value,
  153.      then re-attaching the table.
  154.  
  155.      In the query output, the line beginning with _TTTT_iiii_mmmm_eeee_rrrr_ssss_:::: shows the timer
  156.      values for input and output sides of the module.
  157.  
  158. FFFFIIIILLLLEEEESSSS
  159.      _////_uuuu_ssss_rrrr_////_llll_iiii_bbbb_////_kkkk_bbbb_dddd - directory containing system standard map files.
  160.  
  161. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  162.      _aaaa_llll_pppp_qqqq(1), _kkkk_bbbb_dddd_cccc_oooo_mmmm_pppp(1M), _kkkk_bbbb_dddd_llll_oooo_aaaa_dddd(1M), _aaaa_llll_pppp(7), _kkkk_bbbb_dddd(7).
  163.  
  164. NNNNOOOOTTTTEEEESSSS
  165.      A table may be detached while it is current; however, in this case, it is
  166.      first made non-current; this allows error recovery under adverse
  167.      circumstances.  Detachment of a current table is not affected by the
  168.      current hot-key mode, but always toggles to a state where no table is
  169.      current.
  170.  
  171.      It is not possible with the _----_qqqq option to see the timer values assigned to
  172.      currently attached tables, nor to reset the value for a table that is
  173.      currently attached.
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                                                         PPPPaaaaggggeeee 3333
  195.  
  196.  
  197.  
  198.